GetSerialNoRecordBySN

SoftwareShield CheckPoint™ License Server > CheckPoint™ License Server Interfaces > CheckPoint_Webservice_References > GetSerialNoRecordBySN

## GetSerialNoRecordBySN

The GetSerialNoRecordBySN function will get all serial numbers using a serial number as a reference.

###### Syntax

TRecordResponse * GetSerialNoRecordBySN( BSTR ASerialNo, TCheckPointUserRecord *& ACheckPointUserRecord ) ;

###### Parameters

ASerialNo

[IN] This is a string value that represents the Serial Number. It is used to identify which Serial Number record to retrieve.

ACheckPointUserRecord

[IN] This is a TCheckPointSNSerialRecord class which will be returned to the user. This class will contain the SerialNumber record that is retrieved. The fields of interest are:

- SNSerialsID- the license id

- CheckPointUserID - the user id of the Checkpoint User who generated the serial number. Note that this is the CheckPoint User, not the End User.

- LicenseID - The license ID that is associated with this Serial Number

- SerialNumber - The Serial Number that was generated.

- AuthDefIDNo - the Authorization Definition ID that is associated to this Serial Number

- AuthParameter - If a parameter is necessary for the Authorization Definition, then you would declare it in this field.

- TotalActivationsPermitted - the number of permitted activations allowed for the serial number

- OverflowActivationsPermitted - the number of overflows allowed for the serial number

- ActivationsConsumed - the number of activations consumed (Under regular circumstances, this should be 0)

- OrderNo- the order number that you wish to associate with this Serial Number

- Deleted - if the record was deleted

###### Remarks

The return value of this function is to verify that it was successful. The retrieved user record will be located in the out parameter ACheckPointSNRecord.

###### Return Value

- Returns the custom class TRecordResponse. The fields of interest that is related to this method are:

- Success- True will be returned if this function was successful, otherwise false will be returned.

- PrimaryKeyValue- the Serial Number ID of the user that is retrieved.

- ErrorMessage- if an error occurred, the associated error message can be found in this field.

###### Function Information

Exposed By Interface: | "ICheckPointService"
Exposed In ISAPI DLL: | "checkpoint.dll"